Bagaimana cara mendaftarkan API baru yang akan dimonitor?

1. Akses modul Web/API Monitoring → Web/API Status.

   

2. Dari halaman utama Web Status, klik tombol Add Web/API,

   

3. Selanjutnya akan muncul form untuk mengisi detail API yang akan dimonitor.

   

4. Isi data pada form tersebut dengan rincian sebagai berikut:

   Jenis Isian	Keterangan
   Name	Nama dari API yang akan dimonitor.
   Interval check	Rentang waktu diperiksanya status API secara berkala.
   User Group	Diisi dengan pilihan user group. Anda dapat memilih lebih dari 1 user group. Web/API yang telah didaftarkan untuk setiap User Group, tidak dapat diakses User Group lainnya (Kecuali pada User Group Default* dan User Group parent*).
   Probe	Pilihan probe yang akan bertugas mengambil data dari API yang dimonitor. Jika ingin menambahkan probe baru, klik Add New Probe.
   Tagging (opsional)	PLabel atau tanda untuk mengidentifikasi dan mengelompokkan data Web/API dengan lebih mudah. Pengguna dapat mengetik tagging yang ingin dibuat atau memilih tagging yang sudah pernah ditambahkan sebelumnya.
   URL/IP	Alamat URL atau alamat IP dari API yang akan dimonitor. Mendukung 2 protokol, yaitu HTTP dan HTTPS.
   Alert Threshold	Ambang batas response time yang ditentukan untuk API yang akan dimonitor (diisi dalam satuan milisecond)

5. Selanjutnya, tambahkan request dan kondisi response yang diharapkan (opsional) dengan rincian sebagai berikut:

   Jenis Isian		Keterangan
   Request	Method	Request method yang menunjukkan tindakan yang diinginkan untuk dilakukan terhadap API yang akan dimonitor.
   	Request headers	Request header yang dapat digunakan dalam HTTP request untuk memberikan informasi tentang konteks permintaan.
   	Body	Data opsional yang terkait dengan request.
   	Username	Username yang digunakan untuk mengakses API jika API tersebut memerlukan autentikasi.
   	Password	Password yang digunakan untuk mengakses API jika API tersebut memerlukan autentikasi.
   Response Codition	Status Code	Kode status HTTP yang diharapkan keluar sebagai response dari API yang dimonitor.
   	Match Header	Response header yang diharapkan keluar sebagai response dari API yang dimonitor.
   	Match Body	Data di dalam response body yang diharapkan keluar sebagai response dari API yang dimonitor.
   Keterangan: Jika Status Code, Match Header, atau Match Body yang diinputkan tidak ada di dalam response, maka status API tersebut dianggap down karena tidak sesuai dengan kondisi yang diharapkan.

6. Klik tombol Add Data untuk menambahkan API baru.

Contoh Menambahkan API Baru

Basic Authentication

Sebagai contoh skenario, Anda ingin memonitor sebuah API yang menggunakan Basic Authentication setiap 1 menit sekali. Anda ingin memastikan bahwa API tersebut berjalan dengan lancar dalam arti memberikan kode respon 200. Untuk kebutuhan Authentication, Anda perlu menginputkan username dan password. Maka contoh isi form Add Web/API pada skenario ini adalah sebagai berikut:

Tanpa Basic Authentication

Sebagai contoh skenario, Anda ingin memonitor sebuah API setiap 1 menit sekali. API tersebut memiliki method Get dan tidak menggunakan Basic Authentication . Anda ingin memastikan bahwa API tersebut berjalan dengan lancar dalam arti memberikan kode respon 200 dan Match Body yang mengandung kata “email” . Maka contoh isi form Add Web/API pada skenario ini adalah sebagai berikut:

Bearer Token Authentication

Sebagai contoh skenario, Anda ingin memonitor sebuah API yang menggunakan Bearer Token Authentication setiap 1 menit sekali. Anda ingin memastikan bahwa I tersebut berjalan dengan lancar dalam arti memberikan kode respon 200. Untuk kebutuhan I, Anda perlu menginputkan Bearer Token. Anda pun dapat menambahkan kondisi dari Response Header yang diharapkan keluar sebagai response dari API yang ingin Anda monitor tersebut pada kolom Match Header. Maka contoh isi form Add Web/API pada skenario ini adalah sebagai berikut: